WikiPages/it

Other languages:

Questa pagina è un'estensione della pagina Help:Editing e fornisce linee guida comuni per scrivere e aggiornare la documentazione wiki di FreeCAD. Riassume diverse discussioni e sessioni di brainstorming

Prima di iniziare

Linee guida generali

Descrizioni concise

Quando si descrive FreeCAD si deve cercare di essere concisi e diretti ed evitare ripetizioni. Descrivere cosa fa FreeCAD, non cosa non fa FreeCAD. Evitare anche espressioni colloquiali come "una coppia". Utilizzare "alcuni" quando si ha a che fare con un numero indeterminato o specificare la quantità corretta.

Descrizione errata
Ambiente PartDesign: PartDesign è un ambiente di lavoro per la progettazione di parti che mira a fornire strumenti per la modellazione di parti solide complesse.
Descrizione corretta
Ambiente PartDesign: mira a fornire strumenti per la modellazione di parti solide complesse.

Informazioni centralizzate

Evitare di duplicare le stesse informazioni in luoghi diversi. Inserire le informazioni in una nuova pagina e collegarsi a questa pagina da altre pagine che richiedono queste informazioni.

Non utilizzare la transclusione delle pagine (Help:Editing#Templates and transclosure pagine), poiché ciò rende difficile la traduzione del wiki. Utilizzare solo i modelli descritti di seguito in #Templates.

Stile

I modelli vengono utilizzati per definire lo stile delle pagine della guida. Conferiscono alla documentazione un aspetto coerente. C'è un modello per i comandi di menu, File → Salva, un modello per definire lo stile dei tasti da premere, Shift, per mostrare un valore booleano, true, ecc. Per favore acquisire familiarità con la sezione #Templates prima di scrivere pagine di aiuto.

Flag temporanei

Se si sta lavorando su una pagina di grandi dimensioni è consigliabile contrassegnare la pagina come work in progress o come incompiuta. Ciò garantisce che gli amministratori wiki non contrassegnino la tua pagina come pronta per la traduzione mentre la si sta ancora modificando.

Per contrassegnare una pagina, aggiungere come prima linea {{Page in progress}} o {{UnfinishedDocu}}. Con {{UnfinishedDocu}} si invitano gli altri a collaborare per finire la pagina, mentre {{Page in progress}} indica che si svolgerà il lavoro da solo e che gli altri dovrebbero lasciarti un po' di tempo.

Una volta terminato il lavoro, non dimenticare di rimuovere i flag!

Esempi

Per acquisire rapidamente familiarità con la struttura e lo stile del wiki di FreeCAD, guardare la pagina del modello: modello di base.

Struttura

L'Hub degli utenti fornisce un Sommario. Viene utilizzato come riferimento principale per creare automaticamente la guida offline raggiungibile da FreeCAD, nonché la documentazione PDF offline.

Il Template:Docnav viene utilizzato per collegare in sequenza le pagine, seguendo la struttura del Sommario. Vedere #Templates per un elenco di tutti i modelli.

Nomi delle pagine

I nomi delle pagine dovrebbero essere brevi e dovrebbero usare le maiuscole: ogni parola dovrebbe iniziare con una lettera maiuscola, a meno che non si tratti di articoli, preposizioni, congiunzioni o altre particelle grammaticali (ad esempio 'di', 'su', 'in', 'a ', 'uno', 'e').

Nome della pagina errato
Construction of AeroCompany airplanes
Nome della pagina corretto
Construction of AeroCompany Airplanes

I nomi delle pagine dell'ambiente di lavoro del livello superiore devono avere questo formato: XYZ Workbench, dove XYZ è il nome del workbench, ad esempio PartDesign Workbench. E i nomi delle pagine che descrivono i comandi (o strumenti) appartenenti a un ambiente devono avere questo formato: Comando XYZ, ad esempio PartDesign Pad. Tenere presente che si dovrebbe utilizzare il nome del comando così come appare nel codice sorgente.

Intestazioni

I titoli dei paragrafi dovrebbero essere brevi e utilizzare maiuscole e minuscole: tutte le parole, tranne la prima e i nomi propri, dovrebbero essere in minuscolo. Non si dovrebbero utilizzare le intestazioni H1 (= Heading =) nel markup della wiki, in quanto nel titolo della pagina viene aggiunto automaticamente come intestazione principale H1.

Link

Si dovrebbe utilizzare il nome del collegamento originale per i collegamenti quando possibile. Questo rende più evidente la pagina di riferimento nella documentazione stampata oppure offline. Si prega di evitare parole prive di significato per il collegamento.

Collegamento errato
Per ulteriori informazioni sul disegno di oggetti 2D, fare clic qui.
Collegamento corretto
Per ulteriori informazioni sul disegno di oggetti 2D fare riferimento a Draft.

Il formato preferito per un collegamento è:

[[Name_of_Page/it|Name of Page]]

Tradotto

[[Name_of_Page/fr|Nom de la Page]]

Tenere presente che per la parte prima del carattere |, ovvero il link effettivo, è rilevante la distinzione tra maiuscole e minuscole. Se il nome della pagina è Name_of_page il collegamento non funzionerà se si digita Name_of_Page (P maiuscola). Prima del carattere | tutti gli spazi devono essere sostituiti da trattini bassi (_). Questo serve per aiutare i traduttori che utilizzano software di traduzione, senza i caratteri di sottolineatura il collegamento verrebbe tradotto dal software, il che è indesiderabile.

Per collegarsi a un determinato paragrafo aggiungere un segno # e le sue intestazioni al nome della pagina. Esempio:

[[WikiPages#Links|WikiPages]]

Tradotto

[[WikiPages/fr#Liens|WikiPages]]

All'interno della stessa pagina si può omettere il nome della pagina. Esempio:

[[#Links|Links]]

Per collegarsi alla parte superiore della pagina è possibile utilizzare:

</translate>{{Top}}<translate>

Questo template dovrebbe visualizzare automaticamente il testo corretto a seconda della lingua della pagina. Un collegamento alla parte superiore della pagina è particolarmente utile per le pagine lunghe poiché consente all'utente di tornare rapidamente al sommario. Lo si può mettere alla fine di ogni paragrafo. Assicurarsi che ci sia una riga vuota prima e dopo il template.

Collegamento a una immagine
Testo facoltativo che viene mostrato quando passi il mouse sull'immagine

Per utilizzare un'immagine come collegamento:

[[Image:Draft_Wire.svg|24px|Testo facoltativo che viene mostrato quando passi il mouse sull'immagine|link=Draft_Wire]]

Immagine del Collegamento + testo del collegamento
Draft Wire

Se si tralascia il testo facoltativo, il collegamento stesso verrà mostrato quando si passa sull'immagine, il che è preferibile, e si dovrebbe anche aggiungere un collegamento testuale dopo il collegamento dell'immagine:

[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]

Pagine degli Ambienti di lavoro

Una pagina dell'ambiente di livello superiore dovrebbe iniziare con:

  • Una descrizione dello scopo per cui viene utilizzato l'ambiente.
  • Un'immagine per illustrarne la descrizione.

Vedere #Istantanee dello schermo per le convenzioni su come inserire le immagini.

Pagine dei comandi

Le pagine dei comandi che descrivono gli strumenti dell'ambiente di lavoro non dovrebbero essere troppo lunghe, dovrebbero solo spiegare cosa può fare un comando e cosa no, e come usarlo. Si dovrebbe ridurre al minimo le immagini e gli esempi. I tutorial si possono espandere riguardo l'utilizzo dello strumento e fornire dettagli passo passo.

Per ulteriori dettagli, fare riferimento alla pagina dei Modelli per la descrizione dei comandi.

Tutorial

Un tutorial ben scritto dovrebbe insegnare come ottenere rapidamente determinati risultati pratici. Non dovrebbe essere troppo lungo, ma dovrebbe includere immagini e istruzioni passo passo sufficienti per guidare l'utente. Man mano che FreeCAD si evolve, i tutorial potrebbero diventare obsoleti, quindi è importante menzionare la versione di FreeCAD utilizzata o richiesta per un tutorial.

Per esempi visitare la pagina dei Tutorial.

Templates

Lo stile delle pagine wiki di FreeCAD si ottiene attraverso l'uso di modelli (Help:Editing#Templates_and_transcluding_pages). Garantiscono un aspetto standardizzato in tutte le pagine e consentono anche di rimodellare il wiki. È possibile visualizzare l'elenco completo dei modelli definiti accedendo a Special:PrefixIndex/Template:. Si prega tuttavia di utilizzare solo i modelli elencati nelle tabelle seguenti. Solo in casi molto particolari si possono utilizzare direttamente i tag HTML.

Fare clic sul collegamento del modello per visualizzare le istruzioni di utilizzo di un modello e per visualizzarne l'implementazione. I modelli sono una potente funzionalità del software MediaWiki. Si dovrebbe essere un utente wiki esperto per proporre aggiunte e modifiche ai modelli esistenti. Se implementati in modo errato, i template rendono difficile la traduzione delle pagine in altre lingue, quindi il loro utilizzo dovrebbe essere limitato alla formattazione del testo e la transclusione delle pagine dovrebbe essere evitata. Vedere MediaWiki Help:Templates per ulteriori informazioni.

Template semplici

Questi template accettano un parametro semplice di testo e lo formattano con uno stile particolare.

Template Aspetto Descrizione
Top

Inizio

 Utilizzato per aggiungere un link che porta all'inizio della pagina.
Emphasis emphasis Utilizzato per enfatizzare una parte di testo.
KEY Alt Utilizzato per indicare un tasto della tastiera che deve essere premuto.
ASCII Utilizzato per indicare un tasto ascii in un'immagine (.svg) che deve essere premuto. E' necessario fornire il carattere desiderato oppure il numero del codice ascii del carattere.
Button Cancel Utilizzato per indicare un pulsante nell'interfaccia utente grafica che deve essere premuto.
RadioButton Option Utilizzato per indicare un pulsante di un'opzione nell'interfaccia utente grafica che deve essere Selezionato o No.
CheckBox Option Utilizzato per indicare una casella di controllo nell'interfaccia utente grafica che deve essere Selezionata o No.
SpinBox 1.50 Utilizzato per indicare una casella numerica nell'interfaccia utente grafica che può essere modificata.
ComboBox Menu 1 Utilizzato per indicare una casella combinata nell'interfaccia utente grafica che può essere modificata.
LineEdit Metal Nickel (Ni) Utilizzato per indicare un LineEdit nell'interfaccia utente grafica che può essere modificato.
FALSE, false false, false Utilizzato per indicare un valore booleano falso, ad esempio, come proprietà nell'editor delle proprietà. Questa è una scorciatoia. Poiché si tratta di un valore, preferire il Template Value false
TRUE, true true, true Utilizzato per indicare un valore booleano vero, ad esempio, come proprietà nell'editor delle proprietà. Questa è una scorciatoia. Poiché si tratta di un valore, preferire Template Value true
MenuCommand File → Save Utilizzato per indicare la posizione di un comando all'interno di un particolare menu.
FileName File name Utilizzato per indicare il nome di un file o di una cartella.
SystemInput Type this text Utilizzato per indicare il testo di input digitato dall'utente.
SystemOutput Output text Utilizzato per indicare l'output di testo dal sistema.
Incode import FreeCAD Utilizzato per includere il codice sorgente in linea con un carattere a spaziatura fissa. Dovrebbe stare in una riga.
PropertyView VistaColor Utilizzato per indicare una proprietà View nell'editor delle proprietà. Esempi di proprietà di visualizzazione includono Line Color, Line Width, Point Color, Point Size, ecc..
PropertyData DatiPosition Utilizzato per indicare una proprietà Data nell'editor delle proprietà. Le proprietà dei dati sono diverse per i diversi tipi di oggetti.
Properties Title / TitleProperty Base Utilizzato per indicare il titolo di un gruppo di proprietà nell'editor delle proprietà. Il titolo non verrà incluso nel sommario automatico.
Obsolete obsolete in 0.19 Utilizzato per indicare che una funzionalità è diventata obsoleta nella versione di FreeCAD specificata.
VersionNoteObsolete obsolete in 0.19 Idem (superscript variant).
Version introduced in 0.18 Utilizzato per indicare che una funzionalità è stata introdotta nella versione di FreeCAD specificata.
VersionNote introduced in 0.18 Idem (superscript variant).
VersionMinus 0.16 and below Utilizzato per indicare che una funzionalità è disponibile nella versione di FreeCAD specificata e nelle versioni precedenti.
VersionNoteMinus 0.16 and below Idem (superscript variant).
VersionPlus 0.17 and above Utilizzato per indicare che una funzionalità è disponibile nella versione di FreeCAD specificata e nelle versioni successive.
VersionNotePlus 0.17 and above Idem (superscript variant).
ColoredText Colored Text Questo modello è utilizzato per colorare lo sfondo, il testo o lo sfondo e il testo. (Pagina ColoredText per ulteriori esempi)
ColoredParagraph
Colored Paragraph
 Questo modello è utilizzato per colorare lo sfondo, il testo o lo sfondo e il testo di un intero paragrafo. (Pagina ColoredParagraph per ulteriori esempi)

Template complessi

Questi template richiedono più parametri di input o producono un blocco di testo con un formato particolare.

Template Aspetto Descrizione
Prettytable This table Utilizzato per formattare tabelle come questa. È possibile aggiungere ulteriori proprietà alla tabella.
Caption

Some caption for an image

 Utilizzato per aggiungere una didascalia sotto un'immagine. Può essere allineato a sinistra o al centro.
Clear Utilizato per cancellare le colonne. Seguire la definizione del modello per una spiegazione dettagliata. Viene spesso utilizzato per impedire al testo di scorrere accanto a immagini non correlate.
Code 
import FreeCAD
Utilizzato per includere esempi di codice su più righe con un carattere a spaziatura fissa. Il linguaggio predefinito è Python, ma è possibile specificare altri linguaggi.

Il codice Python deve aderire alle raccomandazioni generali stabilite da PEP8: Style Guide for Python Code. In particolare, le parentesi dovrebbero seguire immediatamente il nome della funzione e uno spazio dovrebbe seguire una virgola. Ciò rende il codice più leggibile.

CodeDownload
Utilizzato per creare un collegamento su una pagina di una macro.
Codeextralink

Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon Manager. Link for optional manual installation: Macro 


# This code is copied instead of the original macro code
# to guide the user to the online download page.
# Use it if the code of the macro is larger than 64 KB and cannot be included in the wiki
# or if the RAW code URL is somewhere else in the wiki.

from PySide import QtGui, QtCore

diag = QtGui.QMessageBox(QtGui.QMessageBox.Information,
    "Information",
    "This macro must be downloaded from this link\n"
    "\n"
    "https://wiki.freecad.org/Main_Page" + "\n"
    "\n"
    "Quit this window to access the download page")

diag.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint)
diag.setWindowModality(QtCore.Qt.ApplicationModal)
diag.exec_()

import webbrowser 
webbrowser.open("https://wiki.freecad.org/Main_Page")
<class="rawcodeurl"><a href="https://wiki.freecad.org/Main_Page">raw code</a>
 Utilizzato se il codice di una macro è troppo grande per essere ospitato sul Wiki. Il codice può quindi essere ospitato da qualche altra parte e il collegamento non elaborato ad esso può essere specificato con questo modello. Addon Manager utilizzerà questo collegamento.
Fake heading
Heading
 Utilizzato per creare un'intestazione che non verrà inclusa automaticamente nel sommario.
GuiCommand See GuiCommand model Utilizzato per creare un riquadro con informazioni utili per documentare i comandi dell'ambiente di lavoro (strumenti).
TutorialInfo See for example Basic modeling tutorial Utilizzato per creare un box con informazioni utili per documentare i tutorial.
Macro See for example Macro FlattenWire Utilizzato per creare un box con informazioni utili per documentare le macro.
Docnav
Online Help Startpage
Feature list
Utilizzato per creare una barra con frecce e collegamenti appropriati, adatto a disporre le pagine in una sequenza particolare.
VeryImportantMessage
Important Message
 Utilizzato per creare una casella evidenziata con un messaggio molto importante. Utilizzare con parsimonia, solo per indicare gravi problemi nella funzionalità del software, interruzione degli strumenti e cose simili.
Page in progress
This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.
Utilizzato per le pagine che sono ancora in elaborazione o che sono attualmente in fase di rielaborazione. Non dimenticarsi di rimuoverlo quando la pagina è completata.
UnfinishedDocu

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Utilizzato per creare una casella evidenziata che indica una pagina di documentazione incompleta.
Softredirect Utilizzato al posto del reindirizzamento normale, quando si sta reindirizzando a una pagina speciale (come Media: o Categoria:), nei quali casi il reindirizzamento normale è disabilitato.
Quote

Cry "Havoc" and let slip the dogs of war.

—William Shakespeare, Julius Caesar, act III, scene I
 Utilizzato per creare una casella di testo con una citazione letterale e un riferimento.
Userdocnavi, Powerdocnavi Utilizzati per creare caselle di navigazione per la documentazione per l'utente, la documentazione per utenti esperti e la documentazione per sviluppatori. Ciò consente di saltare rapidamente tra le diverse sezioni della documentazione. Inoltre inseriscono la pagina corrispondente nella categoria corretta.

Grafica

Immagini e screenshot sono necessari per produrre una documentazione completa di FreeCAD. Sono particolarmente utili per illustrare esempi e tutorial. Le immagini devono essere mostrate nella loro dimensione originale, in modo che presentino dettagli sufficienti e siano leggibili se includono testo. Le immagini Bitmap non devono essere ridimensionate.

Evitare le immagini animate (GIF) nelle pagine generiche di aiuto. Le animazioni e i video devono essere riservati ai tutorial non destinati a essere utilizzati come documentazione PDF offline.

Le immagini possono essere caricate tramite la pagina Special:Upload.

Nome

Dare nomi significativi alle proprie immagini. Se si ha un'immagine che mostra le caratteristiche di un particolare comando, si dovrebbe usare il nome di quel comando con _example alla fine. Ad esempio per il comando Draft Offset l'immagine dovrebbe essere chiamata Draft_Offset_example.png.

Istantanee dello schermo

Le dimensioni consigliate per le istantanee dello schermo sono:

  • Nativo 400x200 (o larghezza=400 e altezza<=200), per le pagine di riferimento dei comandi, per consentire all'immagine di adattarsi alla parte sinistra della pagina e per altre istantanee standard.
  • Nativo 600x400 (o larghezza=600 e altezza<=400), per le pagine di riferimento dei comandi, quando si ha davvero bisogno di un'immagine più grande e si consente comunque all'immagine di adattarsi alla parte sinistra della pagina e per altre istantanee standard.
  • 1024x768 nativo (o larghezza=1024 e altezza<=768), solo per immagini a schermo intero.
  • Sono possibili taglie più piccole quando si mostrano i dettagli.
  • Evitare immagini con risoluzioni maggiori, poiché non saranno molto trasferibili su altri tipi di display o sulla documentazione PDF stampata.

Non si dovrebbe dipendere da una configurazione personalizzata del proprio desktop o sistema operativo quando si creano schermate e si dovrebbero utilizzare le impostazioni visive predefinite dell'interfaccia di FreeCAD quando possibile.

Per creare uno screenshot si possono utilizzare le opzioni fornite dal proprio sistema operativo, oppure una di queste macro: Macro Snip e Macro Screen Wiki.

Testo

Per facilitare le traduzioni della documentazione, cercare di evitare screenshot che contengono testo. Se non lo si può evitare, prendere in considerazione l'idea di acquisire screenshot separati dell'interfaccia e della Vista 3D. L'immagine della vista 3D può essere riutilizzata in ogni traduzione, mentre un traduttore può, se necessario, acquisire uno screenshot dell'interfaccia localizzata.

Icone e grafica

Fare riferimento alla pagina Artwork per tutti gli elementi grafici e le icone che sono state create per FreeCAD e che possono essere utilizzate anche nelle pagine di documentazione. Se si desidera contribuire alle icone, leggere le Linee guida per le Artwork.

Traduzioni

Per consenso generale, la pagina di riferimento nel wiki è la pagina in inglese, che dovrebbe venire creata per prima. Se si desidera modificare o aggiungere contenuto a una pagina, si dovrebbe farlo prima sulla pagina inglese e, solo una volta completato l'aggiornamento, trasferire la modifica sulla pagina tradotta.

Il wiki di FreeCAD supporta un'estensione di traduzione che consente di gestire più facilmente le traduzioni tra le pagine; per i dettagli, vedere Tradurre il wiki.

Altre risorse utili sono:

Alcuni consigli per i traduttori

Tradurre GuiCommand

{{GuiCommand
|Name=FEM EquationFlux
|MenuLocation=Solve → Flux equation
|Workbenches=[[FEM_Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

Tradotto: 

{{GuiCommand/fr
|Name=FEM EquationFlux
|Name/fr=FEM Équation d'écoulement
|MenuLocation=Solveur → Équation de flux
|Workbenches=[[FEM_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]]
}}

Tradurre navi

{{FEM_Tools_navi}}

Tradotto: 

{{FEM_Tools_navi/fr}}

Tradurre link

[[Part_Workbench|Part Workbench]]

Tradotto: 

[[Part_Workbench/fr|Atelier Part]]

Tradurre Docnav

{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}

Tradotto: 

{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}

Esempio con le icone: 

{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Tradotto: 

{{Docnav/fr
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Std_File_Menu/fr|Menu fichier]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Creare, rinominare ed eliminare le pagine

Creare pagine

Prima di creare una nuova pagina si dovrebbe prima verificare se esiste già una pagina simile. In questo caso, di solito è meglio prima modificare la pagina esistente. In caso di dubbi, aprire prima un topic nel forum delle Wiki.

Per creare una nuova pagina, effettuare una delle seguenti operazioni:

Rinominare le pagine

Poiché FreeCAD è un progetto in costante sviluppo, a volte è necessario rivedere il contenuto del wiki. Se i nomi dei comandi vengono modificati nel codice sorgente, anche le pagine wiki che li documentano dovranno essere rinominate. Questo può essere fatto solo dagli amministratori del wiki. Per informarli, aprire un argomento nel Forum delle Wiki ed elencare l'operazione di ridenominazione necessaria in questo modulo: 

old name         new name
Old_page_name_1  New_page_name_1
Old_page_name_2  New_page_name_2
...

Eliminare file e pagine

Nel caso in cui sia necessario eliminare un file, andare alla relativa pagina (https://www.freecadweb.org/wiki/File:***.***) e modificarlo. Non importa se la pagina è vuota o meno, aggiungere quanto segue come primo elemento: {{Delete}} e direttamente sotto descrivere il motivo per cui la pagina dovrebbe essere eliminata. Inoltre, aprire un topic nel Forum delle Wiki.

Per le pagine la procedura è la stessa.

Discussioni

Il Development/Wiki subforum nel Forum di FreeCAD fornisce uno spazio dedicato per discutere argomenti wiki, l'aspetto delle wiki e qualsiasi altra cosa relativa al wiki. Indirizzare lì le proprie domande e i suggerimenti.

Terminologia - politica di denominazione

Inglese

Vedere il Glossario.

Altre lingue